4.4 查询外部用户列表

基本信息

Path： /api/v1/directory/queryEntity

Method： POST

接口描述：

用户目录ID，userDirectoryId获取方式，用“开发者工具”过滤请求 userDirectory/queryAll，打开控制台“业务管理”->“用户管理”页面，查看响应体数据获取对应用户目录的ID，也可以通过用户目录查询接口获取ID

请求参数

Headers

参数名称	参数值	是否必须	示例	备注
Content-Type	application/json	必须

Body

参数名称	类型	是否必须	默认值	备注	其他信息
userDirectoryId	string	与userDirectoryName二选一		所属用户目录ID	可通过用户目录查询接口获取ID
userDirectoryName	string	与userDirectoryId二选一		所属用户目录名称，ID和名称只需传一个即可，都传时以ID为准
showAll	number	非必须	1	查询所有，1递归查询组织架构下属的所有数据，0只查询直属的数据
include	object[]	必须		查询条件
├─user	object	必须		用户的查询条件
├─├─pageSize	number	非必须	20	分页大小，每页查询的最大数据量，越大查询时间越长
├─├─pageIndex	number	非必须	1	页码
path	string	非必须	'/'	查询条件：所属组织架构路径，查询某个组织架构下属数据，使用该搜索条件时，忽略其余条件
searchData	string[]	非必须		查询条件：模糊搜索关键字，仅支持搜索单个值，传入多个值时仅首个值生效

请求示例

{
    "userDirectoryId": "04bac940-fbf9-11ea-9906-116c10ccbb30",
    "showAll": 1,
    "include": {
        "user": {
            "pageSize": 20,
            "pageIndex": 1,
        }
    },
}

返回数据

名称	类型	是否必须	备注
code	number	必须	返回码，0 返回成功
data	object	必须	报文数据主体
├─ user	object	必须	数据主体
├─├─ count	number	必须	查询结果的数据总数
├─├─ pageCount	number	必须	查询结果的数据总页数
├─├─ pageSize	number	必须	页大小，每页的最大数据数
├─├─ pageIndex	number	必须	页码
├─├─ data	object[]	必须	查询结果数据主体
├─├─├─ id	string	必须	用户ID
├─├─├─ name	string	必须	名称
├─├─├─ domain	string	必须	所属域
├─├─├─ path	string	必须	所属组织架构
├─├─├─ description	string	必须	描述
├─├─├─ phone	string	必须	手机号码
├─├─├─ status	number	必须	启用状态，0禁用，1启用
├─├─├─ email	string	必须	电子邮件
├─├─├─ expiredTime	string	必须	过期时间，时间戳，13位长度，单位毫秒，'0'表示永不过期
├─├─├─ createdAt	string	必须	创建时间
├─├─├─ updatedAt	string	必须	更新时间
├─├─├─ band	string	必须	群组名称列表字符串，以逗号分隔
├─├─├─ creator	string	必须	创建者
├─├─├─ authCompose	object	必须	认证策略
├─├─├─├─ id	string	必须	策略ID
├─├─├─├─ name	string	必须	策略名称
├─├─├─ userPolicy	object	必须	用户策略
├─├─├─├─ id	string	必须	策略ID
├─├─├─├─ name	string	必须	策略名称
msg	string	必须	返回提示信息，与返回码对应

返回示例

{
    "code": 0,
    "data": {
        "group": {
            "data": [{
                "id": "908b7415-a333-11eb-bc20-21be2d4cebdc",
                "name": "test",
                "path": "/",
                "description": "",
                "entityType": "user",
                "domain": "testladap",
                "status": 1,
                "isDeleted": 0,
                "externalId": "22",
                "expiredTime": "0",
                "band": "",
                "roleNames": "",
                "createdAt": "Thu Apr 22 2021 14:25:42 GMT+0800 (Coordinated Universal Time)",
                "updatedAt": "Thu Apr 22 2021 14:25:42 GMT+0800 (Coordinated Universal Time)"
            }],
            "count": 1,
            "pageCount": 1,
            "pageSize": 20,
            "pageIndex": 1
        }
    },
    "msg": "请求成功"
}

错误信息

错误提示	错误码
参数检查出错	10000001
用户目录不存在	77200001

4.4 查询外部用户列表

4.4 查询外部用户列表

results matching ""

No results matching ""